/*
 * Copyright (c) 2021 VMware, Inc.
 * SPDX-License-Identifier: MIT
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.dbsp.algebraic;

/**
 * Abstract interface implemented by values that can represent time.
 */
public interface Time {
    /**
     * @return  True if this is the zero time.
     */
    boolean isZero();

    /**
     * @return Previous time if defined (throws if time is zero).
     */
    Time previous();

    /**
     * @return Next time.
     */
    Time next();

    /**
     * Compare two times.
     * @param time  Time to compare to on the right.
     * @return -1, 0, or 1 depending on how this compares with time.
     */
    int compareTo(Time time);

    /**
     * Compare two times for equality.
     * @param other  Time to compare with.
     * @return  True if the times are equal.
     */
    default boolean equals(Time other) {
        return this.compareTo(other) == 0;
    }

    /**
     * Current time as integer value; throws if this overflows.
     */
    int asInteger();
}
